home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3dm / audio / ALgetfilled.z / ALgetfilled
Encoding:
Text File  |  1998-10-20  |  3.4 KB  |  67 lines
  1.  
  2.  
  3.  
  4. AAAALLLLggggeeeettttffffiiiilllllllleeeedddd((((3333ddddmmmm))))                                              AAAALLLLggggeeeettttffffiiiilllllllleeeedddd((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ALgetfilled - (obsolete) return the number of filled sample locations in
  10.      an audio port
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiioooo....hhhh>>>>
  14.  
  15.      lllloooonnnngggg AAAALLLLggggeeeettttffffiiiilllllllleeeedddd((((AAAALLLLppppoooorrrrtttt ppppoooorrrrtttt))))
  16.  
  17. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  18.      _p_o_r_t   expects the audio port you want to query.  This structure is the
  19.             returned value of an AAAALLLLooooppppeeeennnnppppoooorrrrtttt((((3333ddddmmmm)))) call.
  20.  
  21. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  22.      AAAALLLLggggeeeettttffffiiiilllllllleeeedddd is obsolete and is provided for backward compatibility.  The
  23.      preferred function is _a_l_G_e_t_F_i_l_l_e_d(_3_d_m), which returns the number of
  24.      filled sample frames in a port.
  25.  
  26.      AAAALLLLggggeeeettttffffiiiilllllllleeeedddd((((3333ddddmmmm)))) returns the number of samples now in the audio port.
  27.      How you interpret this number depends on whether _p_o_r_t is an input port or
  28.      an output port.
  29.  
  30.      For an input port, the return value is the greatest number of samples
  31.      that can be read from the port without blocking (waiting for more samples
  32.      to come into the port).
  33.  
  34.      For an output port, the return value is the number of samples yet to be
  35.      played.
  36.  
  37.      Because the port continues to empty or fill, the number returned by
  38.      AAAALLLLggggeeeettttffffiiiilllllllleeeedddd((((3333ddddmmmm)))) is an instantaneous measurement of the number of filled
  39.      locations.  For input ports this number will increase over time as new
  40.      samples arrive.  For output ports this number will decrease as samples
  41.      are played.
  42.  
  43.      In order to insure the best possible performance, AAAALLLLggggeeeettttffffiiiilllllllleeeedddd((((3333ddddmmmm))))
  44.      performs no verification of _p_o_r_t. You should make certain that _p_o_r_t is a
  45.      valid AAAALLLLppppoooorrrrtttt structure before passing it as a parameter to
  46.      AAAALLLLggggeeeettttffffiiiilllllllleeeedddd((((3333ddddmmmm)))).
  47.  
  48. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  49.      Upon successful completion, AAAALLLLggggeeeettttffffiiiilllllllleeeedddd((((3333ddddmmmm)))) will return a non-negative
  50.      number.
  51.  
  52. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  53.      ALopenport(3dm), ALgetfillable(3dm), ALgetfillpoint(3dm)
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.